<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>avbuf: xavbuf_clk.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">avbuf
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xavbuf__clk_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xavbuf_clk.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains PLL configuring functions. </p>
<p>These Functions calculates and configures the PLL depending on desired frequency.</p>
<dl class="section note"><dt>Note</dt><dd>None.</dd></dl>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.0   mh  06/24/17 Initial release.
2.1   tu  12/29/17 LPD and FPD offsets adjusted
2.6   rv  05/02/23 Added PLL macros
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a1ec626441b798f852839e336c4ea726f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xavbuf__clk_8c.html#a1ec626441b798f852839e336c4ea726f">XAVBuf_SetPixelClock</a> (u64 FreqHz)</td></tr>
<tr class="memdesc:a1ec626441b798f852839e336c4ea726f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function calls API to calculate and configure PLL with desired frequency for Video.  <a href="#a1ec626441b798f852839e336c4ea726f">More...</a><br/></td></tr>
<tr class="separator:a1ec626441b798f852839e336c4ea726f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4dd63e9fd6add1757a3761690b706e1d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xavbuf__clk_8c.html#a4dd63e9fd6add1757a3761690b706e1d">XAVBuf_SetAudioClock</a> (u64 FreqHz)</td></tr>
<tr class="memdesc:a4dd63e9fd6add1757a3761690b706e1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function calls API to calculate and configure PLL with desired frequency for Audio.  <a href="#a4dd63e9fd6add1757a3761690b706e1d">More...</a><br/></td></tr>
<tr class="separator:a4dd63e9fd6add1757a3761690b706e1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a4dd63e9fd6add1757a3761690b706e1d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XAVBuf_SetAudioClock </td>
          <td>(</td>
          <td class="paramtype">u64&#160;</td>
          <td class="paramname"><em>FreqHz</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function calls API to calculate and configure PLL with desired frequency for Audio. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">FreqHz</td><td>is the desired frequency in Hz.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if PLL is configured without an error. XST_FAILURE otherwise.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The Pll used is design specific. </dd></dl>

<p>References <a class="el" href="xavbuf__hw_8h.html#ae00cb3dbc395858edb3b99c538abc4b1">XAVBUF_AUDIO_REF_CTRL</a>, <a class="el" href="xavbuf__hw_8h.html#aa9edccf3d4b47ff9b6ff6fde84a26dd0">XAVBUF_CLK_FPD_BASEADDR</a>, <a class="el" href="xavbuf__hw_8h.html#acc9ef500a33218ad23ee1078c452c219">XAVBuf_ReadReg</a>, and <a class="el" href="xavbuf__hw_8h.html#a755a434c389a82daff000b38de56e0d2">XAVBUF_VPLL_SRC_SEL</a>.</p>

</div>
</div>
<a class="anchor" id="a1ec626441b798f852839e336c4ea726f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XAVBuf_SetPixelClock </td>
          <td>(</td>
          <td class="paramtype">u64&#160;</td>
          <td class="paramname"><em>FreqHz</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function calls API to calculate and configure PLL with desired frequency for Video. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">FreqHz</td><td>is the desired frequency in Hz.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if PLL is configured without an error. XST_FAILURE otherwise.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The Pll used is design specific. </dd></dl>

<p>References <a class="el" href="xavbuf__hw_8h.html#aa9edccf3d4b47ff9b6ff6fde84a26dd0">XAVBUF_CLK_FPD_BASEADDR</a>, <a class="el" href="xavbuf__hw_8h.html#acc9ef500a33218ad23ee1078c452c219">XAVBuf_ReadReg</a>, <a class="el" href="xavbuf__hw_8h.html#adecb43b4a7818f901e9ea65c671981d3">XAVBUF_VIDEO_REF_CTRL</a>, and <a class="el" href="xavbuf__hw_8h.html#a755a434c389a82daff000b38de56e0d2">XAVBUF_VPLL_SRC_SEL</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
